/**
 * @file    jm_frame_port.h
 * @brief   关节电机数据帧接口服务
 * @details This is the detail description.
 * @author  wang-haoyu
 * @date    2025年7月10日 (created)
 * @version 0.0.1
 * @par Copyright (C):
 *          All Rights Reserved.
 * @par Encoding:
 *          UTF-8
 * @par Description        :
 * 1. Hardware Descriptions:
 *      None.
 * 2. Program Architecture:
 *      None.
 * 3. File Usage:
 *      None.
 * 4. Limitations:
 *      None.
 * 5. Else:
 *      None.
 * @par Modification:
 * -# Date          : 2025年7月10日;
 * Revision         : 0.0.1;
 * Author           : wang-haoyu;
 * Contents         :
 */
 
/* =============================================================================
 *                                header files
 * ========================================================================== */
#ifndef __JM_FRAME_PORT_H
#define __JM_FRAME_PORT_H

#include "data.h"
#include "jm_config.h"
#include "jm_error_code.h"
#include "jm_fifo_port.h"
#include "damiao_drv.h"

/* =============================================================================
 *                              macros & constants
 * ========================================================================== */

/* =============================================================================
 *                          data structure definitions
 * ========================================================================== */
typedef struct 
{
    rt_uint32_t (*jm_drv_err_code_analys)(rt_uint8_t );
    void (*jm_drv_enable_set_state)(rt_uint16_t node_id,bool sta_set);
    void (*jm_drv_enable_set_urgent_state)(rt_uint16_t node_id,bool sta_set);
    void (*jm_drv_zero_point_set_state)(rt_uint16_t node_id);
    void (*jm_drv_clear_error_state)(rt_uint16_t node_id);
    void (*jm_drv_ctrl_state)(rt_uint16_t node_id,float pos_des,rt_uint16_t vel_des,rt_uint16_t i_des);
}jm_drv_frame_t;

/* =============================================================================
 *                         static variable definitions
 * ========================================================================== */

/* =============================================================================
 *                         static function definitions
 * ========================================================================== */

/* =============================================================================
 *                         global function definitions
 * ========================================================================== */

/*
 * 关节电机数据帧解包函数
 *
 * Parameter:
 *   Input:
 *		-*fifo_src：fifo接口句柄
 *      -*analys_src:关节电机数据解析参数
 *   Output:
 *      -*info_obj：关节电机数据信息
 * Returns:
 *		-JM_DRV_ENOERR_CODE：返回状态
 */
JM_DRV_ENOERR_CODE jm_drv_frame_unpack(jm_fifo_port_t *fifo_src,jm_data_analys_param_t *analys_src,jm_drv_info_get_t *info_obj,utils_timer_t *timer);

/*
 * 关节电机错误码分析函数
 *
 * Parameter:
 *   Input:
 *		-src:输入
 * Returns:
 * 		错误码
 */
rt_uint32_t jm_drv_error_code_analys(rt_uint8_t src);


/*
 * 关节电机使/失能设置函数
 *
 * Parameter:
 *   Input:
 *		-node_id:驱动器ID号
 *		-sta_set：设置状态
 * Returns:
 */
void jm_drv_enable_set_frame(rt_uint16_t node_id,bool sta_set);

/*
 * 关节电机使/失能紧急设置函数
 *
 * Parameter:
 *   Input:
 *		-node_id:驱动器ID号
 *		-sta_set：设置状态
 * Returns:
 */
void jm_drv_enable_set_urgent_frame(rt_uint16_t node_id,bool sta_set);

/*
 * 关节电机零点设置函数
 *
 * Parameter:
 *   Input:
 *		-node_id:驱动器ID号
 * Returns:
 */
void jm_drv_zero_point_set_frame(rt_uint16_t node_id);

/*
 * 关节电机清错设置函数
 *
 * Parameter:
 *   Input:
 *		-node_id:驱动器ID号
 * Returns:
 */
void jm_drv_clear_error_frame(rt_uint16_t node_id);

/*
 * 关节电机控制函数
 *
 * Parameter:
 *   Input:
 *		-node_id:驱动器ID号
 *		-pos_des:位置设置
 *		-vel_des:速度限制设置
 *		-i_des:力矩设置
 * Returns:
 */
void jm_drv_ctrl_frame(rt_uint16_t node_id,float pos_des,rt_uint16_t vel_des,rt_uint16_t i_des);

#endif

/*******************************************************************************
 *                                  EOF
 ******************************************************************************/